/*******************************************************************************
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 * Copyright (c) 2011 Michael Chan.
 ******************************************************************************/
package com.google.code.solrdimension.config.converters;

import java.util.List;

import com.google.code.solrdimension.config.dimensionvalue.AbstractDimensionValueConfig;
import com.google.code.solrdimension.indexmodifiers.IndexModAction;
import com.google.code.solrdimension.parsers.beans.Dimension;
import com.google.code.solrdimension.parsers.beans.DimensionValue;

/**
 * All DimensionValue to DimensionValueConfig converter should implement this interface or inherit 
 * from {@link AbstractDimensionConfigConverter} and have the config type mapping register in the 
 * DimensionValue2ConfigConverterMap spring bean
 * 
 * @author mhc
 *
 */
public interface DimensionValueConverter {
    
    /**
     * 
     * @param dimensionValues
     *            The list of dimensionValues to be convert
     * @param dimension
     *            This Dimension encapsulating the dimension values
     * @return
     *            A list of DimensionValueConfig
     *            
     * @throws UnsupportedOperationException
     *            If the source / target type are not the expected type
     */
    public List<? extends AbstractDimensionValueConfig> convert(List<? extends DimensionValue> dimensionValues, Dimension dimension) throws UnsupportedOperationException;

    
    
    
}
